Release 10.1A: OpenEdge Application Server:
Administration

Editing the properties file

OpenEdge stores the configurations for both the NameServer and AppServer products in a properties file (ubroker.properties). The UNIX and Windows ubroker.properties files are the same except for platform-specific differences (for example, differences in directory path separators, and the differences between environment variable references on UNIX and registry references in Windows).

The properties file stores all the configuration definitions for all instances of the NameServer, and all instances of any AppServer, AppServer Internet Adapter, WebSpeed Server, Web Services Adapter, OpenEdge Adapter for SonicMQ, and DataServer product that run on the same machine. Each configuration definition contains environment variables, registry entries (if Windows), and property settings for each product instance.

There is one copy of this file for each OpenEdge installation. Thus, if you install the NameServer on a separate machine from the AppServer product that it manages, the NameServer and AppServer product each have their own copy of the ubroker.properties file.

The AdminServer reads and updates this file according to your instructions using the Progress Explorer and management utilities. The ubroker.properties file is installed in the properties subdirectory of the OpenEdge installation directory (for example, OpenEdge-Install-Directory/properties/ubroker.properties on UNIX, or OpenEdge-Install-Directory\properties\ubroker.properties in Windows). For the AdminServer to access the properties file, the file must reside in this directory.

Guidelines for editing the properties file

When editing the ubroker.properties file without the Progress Explorer, note that:

You should not directly change the values in the ubroker.properties file unless you have a complete understanding of how the changes affect components. When possible, always use the Progress Explorer to make all changes to this file.
Note: You can use the mergeprop utility installed with OpenEdge to manually edit the ubroker.properties file. For information on using mergeprop, see OpenEdge Getting Started: Installation and Configuration .
Always make a copy of this file, edit the copy, and verify the result before replacing the original with your edited copy.
For complete definitions of all the properties and detailed information on how to set them, see the ubroker.properties.README file, as well as the comments included in the properties file itself. Both files reside in the properties directory.

The file consists of a hierarchical structure of configuration entities, where parent entities provide configuration information that you can override or extend in each child entity. Each configuration entity has a name that begins the entity definition, and the definition contains configuration settings for one or more products or product instances.

AppServer entries in the properties file

The AppServer configurations in ubroker.properties can include the entities listed in Table 2–2.

Table 2–2: AppServer configuration entity names

Configuration entity name	Configuration entity function
[UBroker]	Defines default property settings for all AppServers, DataServers, and WebSpeed Transaction Servers.
[UBroker.AS]	Defines default property settings for all instances of an AppServer.
[UBroker.AS.product-instance-name]	Defines property settings for this instance of an AppServer. The ubroker.properties file can contain several of these entities, each with a unique product-instance-name. For an AppServer, product-instance-name is the name you specify for the AppServer instance.

Thus, parent entities provide default values for all of their child entities. For example, the parent [UBroker] contains a set of definitions that can be inherited by its child AppServer product [UBroker.AS] and any other product entities, and then again by its child [UBroker.AS.product-instance-name] and any other product instance entities. However, at any child level, a redefinition of any value supersedes the default value of its parent. All children from the redefinition level down inherit this new value.

Editing and validating the properties file

To edit the properties file directly, use a text editor such as vi or Notepad. Once you edit the properties file, use the following utilities to validate the AppServer configuration information in the file:

NSCONFIG utility — To validate NameServer configurations. For more information on this utility, see OpenEdge Getting Started: Installation and Configuration .
ASCONFIG utility — To validate AppServer configurations. This section describes how to use this utility.

If the file contains any other OpenEdge server configurations (such as for WebSpeed or the OpenEdge Adapter for SonicMQ), run the configuration validation utilities for those Unified Broker products to ensure that these configurations are still valid. For more information, see OpenEdge Getting Started: Installation and Configuration .

Note: If you always use the Progress Explorer, you never have to use these utilities.

The ASCONFIG utility displays the property settings associated with an AppServer configuration, and checks that the syntax and values are valid. You must run the ASCONFIG utility locally on the machine on which the AppServer is running. The utility does not run across the network.

This is the syntax used to invoke the ASCONFIG utility:

Syntax

asconfig [ [ [ -name AppServer-name ] [ -propfile path-to-properties-file ] [ -validate ] ] | -help ]

For more information on the ASCONFIG utility, see the "ASCONFIG" section and the "Summary of management tasks" section.

The following command validates the syntax and views the configurations of all AppServer instances defined within the test.properties file located in the current working directory:

asconfig -propfile test.properties -validate